FrameLib_Parameters Class Reference

#include <FrameLib_Parameters.h>

Classes
class	AutoSerial
class	Info
class	Serial

Public Types
enum	NumericType { kNumericBool, kNumericInteger, kNumericDouble, kNumericNone }
enum	Type {   kValue, kEnum, kString, kArray,   kVariableArray }
enum	ClipMode { kNone, kMin, kMax, kClip }

Public Member Functions
	FrameLib_Parameters (Info *info)
	~FrameLib_Parameters ()
unsigned long	size () const
long	getIdx (const char *name) const
void	addBool (unsigned long index, const char *name, bool defaultValue=false, long argumentIdx=-1)
void	addDouble (unsigned long index, const char *name, double defaultValue=0.0, long argumentIdx=-1)
void	addInt (unsigned long index, const char *name, long defaultValue=0, long argumentIdx=-1)
void	addString (unsigned long index, const char *name, long argumentIdx=-1)
void	addEnum (unsigned long index, const char *name, long argumentIdx=-1)
void	addEnumItem (unsigned long index, const char *str)
void	addBoolArray (unsigned long index, const char *name, long defaultValue, size_t size, long argumentIdx=-1)
void	addIntArray (unsigned long index, const char *name, long defaultValue, size_t size, long argumentIdx=-1)
void	addDoubleArray (unsigned long index, const char *name, double defaultValue, size_t size, long argumentIdx=-1)
void	addVariableBoolArray (unsigned long index, const char *name, long defaultValue, size_t maxSize, size_t size, long argumentIdx=-1)
void	addVariableIntArray (unsigned long index, const char *name, long defaultValue, size_t maxSize, size_t size, long argumentIdx=-1)
void	addVariableDoubleArray (unsigned long index, const char *name, double defaultValue, size_t maxSize, size_t size, long argumentIdx=-1)
void	setInstantiation ()
void	setMin (double min)
void	setMax (double max)
void	setClip (double min, double max)
void	set (Serial *serialised)
void	set (unsigned long idx, bool value)
void	set (const char *name, bool value)
void	set (unsigned long idx, long value)
void	set (const char *name, long value)
void	set (unsigned long idx, double value)
void	set (const char *name, double value)
void	set (unsigned long idx, char *str)
void	set (const char *name, char *str)
void	set (unsigned long idx, double *values, size_t N)
void	set (const char *name, double *values, size_t N)
void	clear (unsigned long idx)
void	clear (const char *name)
std::string	getName (unsigned long idx) const
long	getArgumentIdx (unsigned long idx) const
long	getArgumentIdx (const char *name) const
Type	getType (unsigned long idx) const
Type	getType (const char *name) const
NumericType	getNumericType (unsigned long idx) const
NumericType	getNumericType (const char *name) const
std::string	getTypeString (unsigned long idx) const
std::string	getTypeString (const char *name) const
ClipMode	getClipMode (unsigned long idx) const
ClipMode	getClipMode (const char *name) const
double	getMin (unsigned long idx) const
double	getMin (const char *name) const
double	getMax (unsigned long idx) const
double	getMax (const char *name) const
void	getRange (unsigned long idx, double *min, double *max) const
void	getRange (const char *name, double *min, double *max) const
std::string	getItemString (unsigned long idx, unsigned long item) const
std::string	getItemString (const char *name, unsigned long item) const
std::string	getInfo (unsigned long idx) const
std::string	getInfo (const char *name) const
double	getDefault (unsigned long idx) const
double	getDefault (const char *name) const
std::string	getDefaultString (unsigned long idx) const
std::string	getDefaultString (const char *name) const
double	getValue (unsigned long idx) const
double	getValue (const char *name) const
long	getInt (unsigned long idx) const
long	getInt (const char *name) const
long	getBool (unsigned long idx) const
bool	getBool (const char *name) const
const char *	getString (unsigned long idx) const
const char *	getString (const char *name) const
const double *	getArray (unsigned long idx) const
const double *	getArray (const char *name) const
const double *	getArray (unsigned long idx, size_t *size) const
const double *	getArray (const char *name, size_t *size) const
size_t	getArraySize (unsigned long idx) const
size_t	getArraySize (const char *name) const
size_t	getArrayMaxSize (unsigned long idx) const
size_t	getArrayMaxSize (const char *name) const
bool	changed (unsigned long idx)
bool	changed (const char *name)

Member Enumeration Documentation

ClipMode

enum FrameLib_Parameters::ClipMode

Enumerator
kNone
kMin
kMax
kClip

NumericType

enum FrameLib_Parameters::NumericType

Enumerator
kNumericBool
kNumericInteger
kNumericDouble
kNumericNone

Type

enum FrameLib_Parameters::Type

Enumerator
kValue
kEnum
kString
kArray
kVariableArray

Constructor & Destructor Documentation

FrameLib_Parameters()

FrameLib_Parameters::FrameLib_Parameters ( Info *  info )

inline

~FrameLib_Parameters()

FrameLib_Parameters::~FrameLib_Parameters ( )

inline

Member Function Documentation

addBool()

void FrameLib_Parameters::addBool ( unsigned long  index, const char *  name, bool  defaultValue = false, long  argumentIdx = -1  )

inline

addBoolArray()

void FrameLib_Parameters::addBoolArray ( unsigned long  index, const char *  name, long  defaultValue, size_t  size, long  argumentIdx = -1  )

inline

addDouble()

void FrameLib_Parameters::addDouble ( unsigned long  index, const char *  name, double  defaultValue = 0.0, long  argumentIdx = -1  )

inline

addDoubleArray()

void FrameLib_Parameters::addDoubleArray ( unsigned long  index, const char *  name, double  defaultValue, size_t  size, long  argumentIdx = -1  )

inline

addEnum()

void FrameLib_Parameters::addEnum ( unsigned long  index, const char *  name, long  argumentIdx = -1  )

inline

addEnumItem()

void FrameLib_Parameters::addEnumItem ( unsigned long  index, const char *  str  )

inline

addInt()

void FrameLib_Parameters::addInt ( unsigned long  index, const char *  name, long  defaultValue = 0, long  argumentIdx = -1  )

inline

addIntArray()

void FrameLib_Parameters::addIntArray ( unsigned long  index, const char *  name, long  defaultValue, size_t  size, long  argumentIdx = -1  )

inline

addString()

void FrameLib_Parameters::addString ( unsigned long  index, const char *  name, long  argumentIdx = -1  )

inline

addVariableBoolArray()

void FrameLib_Parameters::addVariableBoolArray ( unsigned long  index, const char *  name, long  defaultValue, size_t  maxSize, size_t  size, long  argumentIdx = -1  )

inline

addVariableDoubleArray()

void FrameLib_Parameters::addVariableDoubleArray ( unsigned long  index, const char *  name, double  defaultValue, size_t  maxSize, size_t  size, long  argumentIdx = -1  )

inline

addVariableIntArray()

void FrameLib_Parameters::addVariableIntArray ( unsigned long  index, const char *  name, long  defaultValue, size_t  maxSize, size_t  size, long  argumentIdx = -1  )

inline

changed() [1/2]

bool FrameLib_Parameters::changed ( unsigned long  idx )

inline

changed() [2/2]

bool FrameLib_Parameters::changed ( const char *  name )

inline

clear() [1/2]

void FrameLib_Parameters::clear ( unsigned long  idx )

inline

clear() [2/2]

void FrameLib_Parameters::clear ( const char *  name )

inline

getArgumentIdx() [1/2]

long FrameLib_Parameters::getArgumentIdx ( unsigned long  idx ) const

inline

getArgumentIdx() [2/2]

long FrameLib_Parameters::getArgumentIdx ( const char *  name ) const

inline

getArray() [1/4]

const double* FrameLib_Parameters::getArray ( unsigned long  idx ) const

inline

getArray() [2/4]

const double* FrameLib_Parameters::getArray ( const char *  name ) const

inline

getArray() [3/4]

const double* FrameLib_Parameters::getArray ( unsigned long  idx, size_t *  size  ) const

inline

getArray() [4/4]

const double* FrameLib_Parameters::getArray ( const char *  name, size_t *  size  ) const

inline

getArrayMaxSize() [1/2]

size_t FrameLib_Parameters::getArrayMaxSize ( unsigned long  idx ) const

inline

getArrayMaxSize() [2/2]

size_t FrameLib_Parameters::getArrayMaxSize ( const char *  name ) const

inline

getArraySize() [1/2]

size_t FrameLib_Parameters::getArraySize ( unsigned long  idx ) const

inline

getArraySize() [2/2]

size_t FrameLib_Parameters::getArraySize ( const char *  name ) const

inline

getBool() [1/2]

long FrameLib_Parameters::getBool ( unsigned long  idx ) const

inline

getBool() [2/2]

bool FrameLib_Parameters::getBool ( const char *  name ) const

inline

getClipMode() [1/2]

ClipMode FrameLib_Parameters::getClipMode ( unsigned long  idx ) const

inline

getClipMode() [2/2]

ClipMode FrameLib_Parameters::getClipMode ( const char *  name ) const

inline

getDefault() [1/2]

double FrameLib_Parameters::getDefault ( unsigned long  idx ) const

inline

getDefault() [2/2]

double FrameLib_Parameters::getDefault ( const char *  name ) const

inline

getDefaultString() [1/2]

std::string FrameLib_Parameters::getDefaultString

(

unsigned long

idx

)

const

getDefaultString() [2/2]

std::string FrameLib_Parameters::getDefaultString ( const char *  name ) const

inline

getIdx()

long FrameLib_Parameters::getIdx ( const char *  name ) const

inline

getInfo() [1/2]

std::string FrameLib_Parameters::getInfo ( unsigned long  idx ) const

inline

getInfo() [2/2]

std::string FrameLib_Parameters::getInfo ( const char *  name ) const

inline

getInt() [1/2]

long FrameLib_Parameters::getInt ( unsigned long  idx ) const

inline

getInt() [2/2]

long FrameLib_Parameters::getInt ( const char *  name ) const

inline

getItemString() [1/2]

std::string FrameLib_Parameters::getItemString ( unsigned long  idx, unsigned long  item  ) const

inline

getItemString() [2/2]

std::string FrameLib_Parameters::getItemString ( const char *  name, unsigned long  item  ) const

inline

getMax() [1/2]

double FrameLib_Parameters::getMax ( unsigned long  idx ) const

inline

getMax() [2/2]

double FrameLib_Parameters::getMax ( const char *  name ) const

inline

getMin() [1/2]

double FrameLib_Parameters::getMin ( unsigned long  idx ) const

inline

getMin() [2/2]

double FrameLib_Parameters::getMin ( const char *  name ) const

inline

getName()

std::string FrameLib_Parameters::getName ( unsigned long  idx ) const

inline

getNumericType() [1/2]

FrameLib_Parameters::NumericType FrameLib_Parameters::getNumericType

(

unsigned long

idx

)

const

getNumericType() [2/2]

NumericType FrameLib_Parameters::getNumericType ( const char *  name ) const

inline

getRange() [1/2]

void FrameLib_Parameters::getRange ( unsigned long  idx, double *  min, double *  max  ) const

inline

getRange() [2/2]

void FrameLib_Parameters::getRange ( const char *  name, double *  min, double *  max  ) const

inline

getString() [1/2]

const char* FrameLib_Parameters::getString ( unsigned long  idx ) const

inline

getString() [2/2]

const char* FrameLib_Parameters::getString ( const char *  name ) const

inline

getType() [1/2]

Type FrameLib_Parameters::getType ( unsigned long  idx ) const

inline

getType() [2/2]

Type FrameLib_Parameters::getType ( const char *  name ) const

inline

getTypeString() [1/2]

std::string FrameLib_Parameters::getTypeString

(

unsigned long

idx

)

const

getTypeString() [2/2]

std::string FrameLib_Parameters::getTypeString ( const char *  name ) const

inline

getValue() [1/2]

double FrameLib_Parameters::getValue ( unsigned long  idx ) const

inline

getValue() [2/2]

double FrameLib_Parameters::getValue ( const char *  name ) const

inline

set() [1/11]

void FrameLib_Parameters::set ( Serial *  serialised )

inline

set() [2/11]

void FrameLib_Parameters::set ( unsigned long  idx, bool  value  )

inline

set() [3/11]

void FrameLib_Parameters::set ( const char *  name, bool  value  )

inline

set() [4/11]

void FrameLib_Parameters::set ( unsigned long  idx, long  value  )

inline

set() [5/11]

void FrameLib_Parameters::set ( const char *  name, long  value  )

inline

set() [6/11]

void FrameLib_Parameters::set ( unsigned long  idx, double  value  )

inline

set() [7/11]

void FrameLib_Parameters::set ( const char *  name, double  value  )

inline

set() [8/11]

void FrameLib_Parameters::set ( unsigned long  idx, char *  str  )

inline

set() [9/11]

void FrameLib_Parameters::set ( const char *  name, char *  str  )

inline

set() [10/11]

void FrameLib_Parameters::set ( unsigned long  idx, double *  values, size_t  N  )

inline

set() [11/11]

void FrameLib_Parameters::set ( const char *  name, double *  values, size_t  N  )

inline

setClip()

void FrameLib_Parameters::setClip ( double  min, double  max  )

inline

setInstantiation()

void FrameLib_Parameters::setInstantiation ( )

inline

setMax()

void FrameLib_Parameters::setMax ( double  max )

inline

setMin()

void FrameLib_Parameters::setMin ( double  min )

inline

size()

unsigned long FrameLib_Parameters::size ( ) const

inline

---

The documentation for this class was generated from the following files:

• FrameLib_Framework/FrameLib_Parameters.h
• FrameLib_Framework/FrameLib_Parameters.cpp